IoT Sparkplug EIE – UIS Command Component Parameters

UIS Command Component Parameters

The following tables list and describe the parameters specific to the UIS command component types for this remote device:

For more general information about UIS command component parameters, see UIS Command Components. The DG_F_DEV (Get data group from device) and DG_T_DEV (Send data group to device) command component types are configured in the template file. The other command component types are considered ‘special’ and are defined in the EIE editor code. See Special UIS Command Component Types for more information.

CYUPDTPT

Update CygNet Point updates the record for a CygNet point. CYUPDTPT has the following command parameters:

Parameter	Required	Description
FOnErr	No	Fail cmd on update error indicates to abort the UIS command if any update errors are encountered. The errors that might come up include: if the point specified in the Fac, Serv, Site, or UDC parameters does not exist, or if the point exists in a different UIS and any messaging errors or communication failure to that service comes up.
Fac	Yes	Facility for pt identifies the facility of the point to update.
Serv	No	Service for pt identifies the SERVICE of the point to update.
Site	No	Site for pt identifies the SITE of the point to update.
UDC	Yes	UDC for pt identifies the UDC of the point to update.
UType	No	Update type indicates the type of update. Value options are 0 - 3, where 0=Completion, 1=Success, 2=Failure, 3=Creation.
UsrMsk	No	User bit mask specifies the user bit mask of the point to update.
UsrVal	No	User bit value to match specifies the user bit value to match when updating the point record.
Value	No	Value indicates the point value to update.

CYWAITPT

Wait for CygNet Point signals the UIS to wait to perform a command until the value of the specified CygNet point changes to a specified value.

CYWAITPT must be the first command component added to a UIS command. You cannot add other instances of CYWAITPT to a UIS command.

CYWAITPT has the following command parameters:

Parameter	Required	Description
Dur	Yes	Duration is the amount of time (in HH:MM:SS or HH:MM or HH) for the UIS command to wait for the point value to change before timing out.
FOnErr	No	Fail on point error indicates to abort the UIS command if any error conditions are encountered. The point errors that might come up include: if the point specified in the Fac, Serv, Site, or UDC parameters does not exist, or if the point exists in a different UIS and any messaging errors or communication failure to that service comes up.
Fac	Yes	Facility for pt identifies the facility of the point on which to wait for the point value to change before performing the UIS command.
Int	Yes	Interval indicates the frequency (in HH:MM:SS or HH:MM or HH) with which the UIS will check the point’s value to see if it has changed.
Serv	No	Service for pt identifies the SERVICE of the point on which to wait for the point value to change before performing the UIS command.
Site	No	Site for pt identifies the SITE of the point on which to wait for the point value to change before performing the UIS command.
UDC	Yes	UDC for pt identifies the UDC of the point on which to wait for the point value to change before performing the UIS command.
UsrMsk	No	User bit mask specifies the user bit mask on which to wait for the status bit change before issuing the UIS command. Note: The user status bit parameters (UsrMsk and UsrVal) only apply to the extended status field of the point record, so they will not match anything in the base status.
UsrVal	No	User bit value to match specifies the user bit value to match before issuing the UIS command.
Value	No	Value to match specifies the value on which to wait for the point to change to before issuing the UIS command. Note: You can set parameters for both the point user status AND point value. So you can match either one by itself, or you can specify that both must match your parameter values.

DG_T_DEV

Send data group to device sends a data group to a field device. The parent XML Element is uccSendParms. The following parameters are available for each specified data group type.

Data-Group Type	Parameter	Required	Description
CmdDev	CmdId	No	Command ID from the "commands" for a data group in the template file.
FacUdc	No	Facility ID.UDC for point processing
Format	No	Format of the payload data. Value options are: Protobuf JSON
QoS	No	QoS Options are: 0 (message delivered to the server at most once) 1 (message delivered to the server at least once) 2 (message delivered to the server exactly once)
QoSDef	No	Use comm default QoS. Value options are Boolean.
TopicDev	Yes	Topic device ID
TopicGroup	Yes	Topic group ID
TopicNode	Yes	Topic edge node ID
Value	No	Value for the Command ID
CmdNode	CmdId	No	Command ID from the "commands" for a data group in the template file.
FacUdc	No	Facility ID.UDC for point processing
Format	No	Format of the payload data. Value options are: Protobuf JSON
QoS	No	QoS Options are: 0 (message delivered to the server at most once) 1 (message delivered to the server at least once) 2 (message delivered to the server exactly once)
QoSDef	No	Use comm default QoS Value options are Boolean.
TopicGroup	Yes	Topic group ID
TopicNode	Yes	Topic edge node ID
Value	No	Value for the Command ID

Data-Group Type

Parameter

Required

Description

CmdDev

CmdId

Command ID from the "commands" for a data group in the template file.

FacUdc

Facility ID.UDC for point processing

Format

Format of the payload data.

Value options are:

Protobuf
JSON

QoS

QoS

Options are:

0 (message delivered to the server at most once)
1 (message delivered to the server at least once)
2 (message delivered to the server exactly once)

QoSDef

Use comm default QoS.

Value options are Boolean.

TopicDev

Yes

Topic device ID

TopicGroup

Yes

Topic group ID

TopicNode

Yes

Topic edge node ID

Value

Value for the Command ID

CmdNode